<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>IgH EtherCAT Master: domain.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">IgH EtherCAT Master
   &#160;<span id="projectnumber">1.5.2</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('domain_8h.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">domain.h File Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>EtherCAT domain structure.  
<a href="#details">More...</a></p>

<p><a href="domain_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structec__domain.html">ec_domain</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">EtherCAT domain.  <a href="structec__domain.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a62277a562703ecfbf3aad9e3b0ad8c75"><td class="memItemLeft" align="right" valign="top"><a id="a62277a562703ecfbf3aad9e3b0ad8c75"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="domain_8h.html#a62277a562703ecfbf3aad9e3b0ad8c75">ec_domain_init</a> (<a class="el" href="group__ApplicationInterface.html#ga80023c0c77cb39ae1cd70c9d8e5269fc">ec_domain_t</a> *, <a class="el" href="group__ApplicationInterface.html#ga60ec31b46fcf7994c511359402c64baa">ec_master_t</a> *, unsigned int)</td></tr>
<tr class="memdesc:a62277a562703ecfbf3aad9e3b0ad8c75"><td class="mdescLeft">&#160;</td><td class="mdescRight">Domain constructor. <br /></td></tr>
<tr class="separator:a62277a562703ecfbf3aad9e3b0ad8c75"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0673cfe6b046dbc8160068ef776fd0b1"><td class="memItemLeft" align="right" valign="top"><a id="a0673cfe6b046dbc8160068ef776fd0b1"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="domain_8h.html#a0673cfe6b046dbc8160068ef776fd0b1">ec_domain_clear</a> (<a class="el" href="group__ApplicationInterface.html#ga80023c0c77cb39ae1cd70c9d8e5269fc">ec_domain_t</a> *)</td></tr>
<tr class="memdesc:a0673cfe6b046dbc8160068ef776fd0b1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Domain destructor. <br /></td></tr>
<tr class="separator:a0673cfe6b046dbc8160068ef776fd0b1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a145e578c728c987fb2764ea7c30439f1"><td class="memItemLeft" align="right" valign="top"><a id="a145e578c728c987fb2764ea7c30439f1"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="domain_8h.html#a145e578c728c987fb2764ea7c30439f1">ec_domain_add_fmmu_config</a> (<a class="el" href="group__ApplicationInterface.html#ga80023c0c77cb39ae1cd70c9d8e5269fc">ec_domain_t</a> *, <a class="el" href="structec__fmmu__config__t.html">ec_fmmu_config_t</a> *)</td></tr>
<tr class="memdesc:a145e578c728c987fb2764ea7c30439f1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adds an FMMU configuration to the domain. <br /></td></tr>
<tr class="separator:a145e578c728c987fb2764ea7c30439f1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0ca3858bbbb5f744d85d1c6d5aa247c3"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="domain_8h.html#a0ca3858bbbb5f744d85d1c6d5aa247c3">ec_domain_finish</a> (<a class="el" href="group__ApplicationInterface.html#ga80023c0c77cb39ae1cd70c9d8e5269fc">ec_domain_t</a> *, uint32_t)</td></tr>
<tr class="memdesc:a0ca3858bbbb5f744d85d1c6d5aa247c3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Finishes a domain.  <a href="#a0ca3858bbbb5f744d85d1c6d5aa247c3">More...</a><br /></td></tr>
<tr class="separator:a0ca3858bbbb5f744d85d1c6d5aa247c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae3b2fb4aa807084750214357bdba897a"><td class="memItemLeft" align="right" valign="top"><a id="ae3b2fb4aa807084750214357bdba897a"></a>
unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="domain_8h.html#ae3b2fb4aa807084750214357bdba897a">ec_domain_fmmu_count</a> (const <a class="el" href="group__ApplicationInterface.html#ga80023c0c77cb39ae1cd70c9d8e5269fc">ec_domain_t</a> *)</td></tr>
<tr class="memdesc:ae3b2fb4aa807084750214357bdba897a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the number of FMMU configurations of the domain. <br /></td></tr>
<tr class="separator:ae3b2fb4aa807084750214357bdba897a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1a0dbfb47f2634ffacfd0523bb706fde"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="structec__fmmu__config__t.html">ec_fmmu_config_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="domain_8h.html#a1a0dbfb47f2634ffacfd0523bb706fde">ec_domain_find_fmmu</a> (const <a class="el" href="group__ApplicationInterface.html#ga80023c0c77cb39ae1cd70c9d8e5269fc">ec_domain_t</a> *, unsigned int)</td></tr>
<tr class="memdesc:a1a0dbfb47f2634ffacfd0523bb706fde"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a certain FMMU configuration via its position in the list.  <a href="#a1a0dbfb47f2634ffacfd0523bb706fde">More...</a><br /></td></tr>
<tr class="separator:a1a0dbfb47f2634ffacfd0523bb706fde"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>EtherCAT domain structure. </p>

<p class="definition">Definition in file <a class="el" href="domain_8h_source.html">domain.h</a>.</p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="a0ca3858bbbb5f744d85d1c6d5aa247c3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0ca3858bbbb5f744d85d1c6d5aa247c3">&#9670;&nbsp;</a></span>ec_domain_finish()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int ec_domain_finish </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__ApplicationInterface.html#ga80023c0c77cb39ae1cd70c9d8e5269fc">ec_domain_t</a> *&#160;</td>
          <td class="paramname"><em>domain</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>base_address</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Finishes a domain. </p>
<p>This allocates the necessary datagrams and writes the correct logical addresses to every configured FMMU.</p>
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000001">Todo:</a></b></dt><dd>Check for FMMUs that do not fit into any datagram.</dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">0</td><td>Success </td></tr>
    <tr><td class="paramname">&lt;0</td><td>Error code. </td></tr>
  </table>
  </dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">domain</td><td>EtherCAT domain. </td></tr>
    <tr><td class="paramname">base_address</td><td>Logical base address. </td></tr>
  </table>
  </dd>
</dl>

<p class="definition">Definition at line <a class="el" href="domain_8c_source.html#l00226">226</a> of file <a class="el" href="domain_8c_source.html">domain.c</a>.</p>

</div>
</div>
<a id="a1a0dbfb47f2634ffacfd0523bb706fde"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1a0dbfb47f2634ffacfd0523bb706fde">&#9670;&nbsp;</a></span>ec_domain_find_fmmu()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const <a class="el" href="structec__fmmu__config__t.html">ec_fmmu_config_t</a>* ec_domain_find_fmmu </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="group__ApplicationInterface.html#ga80023c0c77cb39ae1cd70c9d8e5269fc">ec_domain_t</a> *&#160;</td>
          <td class="paramname"><em>domain</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned int&#160;</td>
          <td class="paramname"><em>pos</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Get a certain FMMU configuration via its position in the list. </p>
<dl class="section return"><dt>Returns</dt><dd>FMMU at position <em>pos</em>, or NULL. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">domain</td><td>EtherCAT domain. </td></tr>
    <tr><td class="paramname">pos</td><td>List position. </td></tr>
  </table>
  </dd>
</dl>

<p class="definition">Definition at line <a class="el" href="domain_8c_source.html#l00350">350</a> of file <a class="el" href="domain_8c_source.html">domain.c</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="dir_c1346cf4828efdd0d2baf0d391d01b77.html">master</a></li><li class="navelem"><a class="el" href="domain_8h.html">domain.h</a></li>
    <li class="footer">Generated by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
  </ul>
</div>
</body>
</html>
